Google Git
Sign in
chromium / external / gitster / git-htmldocs / 309465b1bf49218ee65ee2e621cedf56bcf8b2c1 / . / technical / api-argv-array.html
blob: c63e2947a6d32c6288bc8e223d2528674e3ca795 [file] [log] [blame]
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]5<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]6<meta name="generator" content="AsciiDoc 8.6.9" />
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]7<title>argv-array API</title>
8<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]9/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10
11/* Default font. */
12body {
13 font-family: Georgia,serif;
14}
15
16/* Title font. */
17h1, h2, h3, h4, h5, h6,
18div.title, caption.title,
19thead, p.table.header,
20#toctitle,
21#author, #revnumber, #revdate, #revremark,
22#footer {
23 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]24}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
30a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
37
38em {
39 font-style: italic;
40 color: navy;
41}
42
43strong {
44 font-weight: bold;
45 color: #083194;
46}
47
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]48h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]50 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
55h1, h2, h3 {
56 border-bottom: 2px solid silver;
57}
58h2 {
59 padding-top: 0.5em;
60}
61h3 {
62 float: left;
63}
64h3 + * {
65 clear: left;
66}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]67h5 {
68 font-size: 1.0em;
69}
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]70
71div.sectionbody {
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]72 margin-left: 0;
73}
74
75hr {
76 border: 1px solid silver;
77}
78
79p {
80 margin-top: 0.5em;
81 margin-bottom: 0.5em;
82}
83
84ul, ol, li > p {
85 margin-top: 0;
86}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]87ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]89
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]90.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]94 padding: 0;
95 margin: 0;
96}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]97pre {
98 white-space: pre-wrap;
99}
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]100
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]101#author {
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]102 color: #527bbd;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]103 font-weight: bold;
104 font-size: 1.1em;
105}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]106#email {
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]107}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]108#revnumber, #revdate, #revremark {
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]109}
110
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]111#footer {
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]112 font-size: small;
113 border-top: 2px solid silver;
114 padding-top: 0.5em;
115 margin-top: 4.0em;
116}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]117#footer-text {
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]118 float: left;
119 padding-bottom: 0.5em;
120}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]121#footer-badges {
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]122 float: right;
123 padding-bottom: 0.5em;
124}
125
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]126#preamble {
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]127 margin-top: 1.5em;
128 margin-bottom: 1.5em;
129}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]130div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]131div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
132div.admonitionblock {
133 margin-top: 1.0em;
134 margin-bottom: 1.5em;
135}
136div.admonitionblock {
137 margin-top: 2.0em;
138 margin-bottom: 2.0em;
139 margin-right: 10%;
140 color: #606060;
141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
149 color: #527bbd;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]150 font-weight: bold;
151 text-align: left;
152 margin-top: 1.0em;
153 margin-bottom: 0.5em;
154}
155div.title + * {
156 margin-top: 0;
157}
158
159td div.title:first-child {
160 margin-top: 0.0em;
161}
162div.content div.title:first-child {
163 margin-top: 0.0em;
164}
165div.content + div.title {
166 margin-top: 0.0em;
167}
168
169div.sidebarblock > div.content {
170 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]171 border: 1px solid #dddddd;
172 border-left: 4px solid #f0f0f0;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]173 padding: 0.5em;
174}
175
176div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]177 border: 1px solid #dddddd;
178 border-left: 5px solid #f0f0f0;
179 background: #f8f8f8;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]180 padding: 0.5em;
181}
182
183div.quoteblock, div.verseblock {
184 padding-left: 1.0em;
185 margin-left: 1.0em;
186 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]187 border-left: 5px solid #f0f0f0;
188 color: #888;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]189}
190
191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
193 text-align: right;
194}
195
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]196div.verseblock > pre.content {
197 font-family: inherit;
198 font-size: inherit;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]199}
200div.verseblock > div.attribution {
201 padding-top: 0.75em;
202 text-align: left;
203}
204/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
205div.verseblock + div.attribution {
206 text-align: left;
207}
208
209div.admonitionblock .icon {
210 vertical-align: top;
211 font-size: 1.1em;
212 font-weight: bold;
213 text-decoration: underline;
214 color: #527bbd;
215 padding-right: 0.5em;
216}
217div.admonitionblock td.content {
218 padding-left: 0.5em;
219 border-left: 3px solid #dddddd;
220}
221
222div.exampleblock > div.content {
223 border-left: 3px solid #dddddd;
224 padding-left: 0.5em;
225}
226
227div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]229a.image:visited { color: white; }
230
231dl {
232 margin-top: 0.8em;
233 margin-bottom: 0.8em;
234}
235dt {
236 margin-top: 0.5em;
237 margin-bottom: 0;
238 font-style: normal;
239 color: navy;
240}
241dd > *:first-child {
242 margin-top: 0.1em;
243}
244
245ul, ol {
246 list-style-position: outside;
247}
248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
252 list-style-type: lower-alpha;
253}
254ol.upperalpha {
255 list-style-type: upper-alpha;
256}
257ol.lowerroman {
258 list-style-type: lower-roman;
259}
260ol.upperroman {
261 list-style-type: upper-roman;
262}
263
264div.compact ul, div.compact ol,
265div.compact p, div.compact p,
266div.compact div, div.compact div {
267 margin-top: 0.1em;
268 margin-bottom: 0.1em;
269}
270
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]271tfoot {
272 font-weight: bold;
273}
274td > div.verse {
275 white-space: pre;
276}
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]277
278div.hdlist {
279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
282div.hdlist tr {
283 padding-bottom: 15px;
284}
285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
289 vertical-align: top;
290 font-style: normal;
291 padding-right: 0.8em;
292 color: navy;
293}
294td.hdlist2 {
295 vertical-align: top;
296}
297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
305
306.footnote, .footnoteref {
307 font-size: 0.8em;
308}
309
310span.footnote, span.footnoteref {
311 vertical-align: super;
312}
313
314#footnotes {
315 margin: 20px 0 20px 0;
316 padding: 7px 0 0 0;
317}
318
319#footnotes div.footnote {
320 margin: 0 0 5px 0;
321}
322
323#footnotes hr {
324 border: none;
325 border-top: 1px solid silver;
326 height: 1px;
327 text-align: left;
328 margin-left: 0;
329 width: 20%;
330 min-width: 100px;
331}
332
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]333div.colist td {
334 padding-right: 0.5em;
335 padding-bottom: 0.3em;
336 vertical-align: top;
337}
338div.colist td img {
339 margin-top: 0.3em;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]340}
341
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]342@media print {
343 #footer-badges { display: none; }
344}
345
346#toc {
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]347 margin-bottom: 2.5em;
348}
349
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]350#toctitle {
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]351 color: #527bbd;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]352 font-size: 1.1em;
353 font-weight: bold;
354 margin-top: 1.0em;
355 margin-bottom: 0.1em;
356}
357
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]359 margin-top: 0;
360 margin-bottom: 0;
361}
362div.toclevel2 {
363 margin-left: 2em;
364 font-size: 0.9em;
365}
366div.toclevel3 {
367 margin-left: 4em;
368 font-size: 0.9em;
369}
370div.toclevel4 {
371 margin-left: 6em;
372 font-size: 0.9em;
373}
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]374
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]375span.aqua { color: aqua; }
376span.black { color: black; }
377span.blue { color: blue; }
378span.fuchsia { color: fuchsia; }
379span.gray { color: gray; }
380span.green { color: green; }
381span.lime { color: lime; }
382span.maroon { color: maroon; }
383span.navy { color: navy; }
384span.olive { color: olive; }
385span.purple { color: purple; }
386span.red { color: red; }
387span.silver { color: silver; }
388span.teal { color: teal; }
389span.white { color: white; }
390span.yellow { color: yellow; }
391
392span.aqua-background { background: aqua; }
393span.black-background { background: black; }
394span.blue-background { background: blue; }
395span.fuchsia-background { background: fuchsia; }
396span.gray-background { background: gray; }
397span.green-background { background: green; }
398span.lime-background { background: lime; }
399span.maroon-background { background: maroon; }
400span.navy-background { background: navy; }
401span.olive-background { background: olive; }
402span.purple-background { background: purple; }
403span.red-background { background: red; }
404span.silver-background { background: silver; }
405span.teal-background { background: teal; }
406span.white-background { background: white; }
407span.yellow-background { background: yellow; }
408
409span.big { font-size: 2em; }
410span.small { font-size: 0.6em; }
411
412span.underline { text-decoration: underline; }
413span.overline { text-decoration: overline; }
414span.line-through { text-decoration: line-through; }
415
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]416div.unbreakable { page-break-inside: avoid; }
417
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]418
419/*
420 * xhtml11 specific
421 *
422 * */
423
424div.tableblock {
425 margin-top: 1.0em;
426 margin-bottom: 1.5em;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]427}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]428div.tableblock > table {
429 border: 3px solid #527bbd;
430}
431thead, p.table.header {
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]432 font-weight: bold;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]433 color: #527bbd;
434}
435p.table {
436 margin-top: 0;
437}
438/* Because the table frame attribute is overriden by CSS in most browsers. */
439div.tableblock > table[frame="void"] {
440 border-style: none;
441}
442div.tableblock > table[frame="hsides"] {
443 border-left-style: none;
444 border-right-style: none;
445}
446div.tableblock > table[frame="vsides"] {
447 border-top-style: none;
448 border-bottom-style: none;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]449}
450
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]451
452/*
453 * html5 specific
454 *
455 * */
456
457table.tableblock {
458 margin-top: 1.0em;
459 margin-bottom: 1.5em;
460}
461thead, p.tableblock.header {
462 font-weight: bold;
463 color: #527bbd;
464}
465p.tableblock {
466 margin-top: 0;
467}
468table.tableblock {
469 border-width: 3px;
470 border-spacing: 0px;
471 border-style: solid;
472 border-color: #527bbd;
473 border-collapse: collapse;
474}
475th.tableblock, td.tableblock {
476 border-width: 1px;
477 padding: 4px;
478 border-style: solid;
479 border-color: #527bbd;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]480}
481
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]482table.tableblock.frame-topbot {
483 border-left-style: hidden;
484 border-right-style: hidden;
485}
486table.tableblock.frame-sides {
487 border-top-style: hidden;
488 border-bottom-style: hidden;
489}
490table.tableblock.frame-none {
491 border-style: hidden;
492}
493
494th.tableblock.halign-left, td.tableblock.halign-left {
495 text-align: left;
496}
497th.tableblock.halign-center, td.tableblock.halign-center {
498 text-align: center;
499}
500th.tableblock.halign-right, td.tableblock.halign-right {
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]501 text-align: right;
502}
503
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]504th.tableblock.valign-top, td.tableblock.valign-top {
505 vertical-align: top;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]506}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]507th.tableblock.valign-middle, td.tableblock.valign-middle {
508 vertical-align: middle;
509}
510th.tableblock.valign-bottom, td.tableblock.valign-bottom {
511 vertical-align: bottom;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]512}
513
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]514
515/*
516 * manpage specific
517 *
518 * */
519
520body.manpage h1 {
521 padding-top: 0.5em;
522 padding-bottom: 0.5em;
523 border-top: 2px solid silver;
524 border-bottom: 2px solid silver;
525}
526body.manpage h2 {
527 border-style: none;
528}
529body.manpage div.sectionbody {
530 margin-left: 3em;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]531}
532
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]533@media print {
534 body.manpage div#toc { display: none; }
535}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]536
537
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]538</style>
539<script type="text/javascript">
540/*<![CDATA[*/
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]541var asciidoc = { // Namespace.
542
543/////////////////////////////////////////////////////////////////////
544// Table Of Contents generator
545/////////////////////////////////////////////////////////////////////
546
547/* Author: Mihai Bazon, September 2002
548 * http://students.infoiasi.ro/~mishoo
549 *
550 * Table Of Content generator
551 * Version: 0.4
552 *
553 * Feel free to use this script under the terms of the GNU General Public
554 * License, as long as you do not remove or alter this notice.
555 */
556
557 /* modified by Troy D. Hanson, September 2006. License: GPL */
558 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
559
560// toclevels = 1..4.
561toc: function (toclevels) {
562
563 function getText(el) {
564 var text = "";
565 for (var i = el.firstChild; i != null; i = i.nextSibling) {
566 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
567 text += i.data;
568 else if (i.firstChild != null)
569 text += getText(i);
570 }
571 return text;
572 }
573
574 function TocEntry(el, text, toclevel) {
575 this.element = el;
576 this.text = text;
577 this.toclevel = toclevel;
578 }
579
580 function tocEntries(el, toclevels) {
581 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]583 // Function that scans the DOM tree for header elements (the DOM2
584 // nodeIterator API would be a better technique but not supported by all
585 // browsers).
586 var iterate = function (el) {
587 for (var i = el.firstChild; i != null; i = i.nextSibling) {
588 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
589 var mo = re.exec(i.tagName);
590 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
591 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
592 }
593 iterate(i);
594 }
595 }
596 }
597 iterate(el);
598 return result;
599 }
600
601 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]602 if (!toc) {
603 return;
604 }
605
606 // Delete existing TOC entries in case we're reloading the TOC.
607 var tocEntriesToRemove = [];
608 var i;
609 for (i = 0; i < toc.childNodes.length; i++) {
610 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]611 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]612 && entry.getAttribute("class")
613 && entry.getAttribute("class").match(/^toclevel/))
614 tocEntriesToRemove.push(entry);
615 }
616 for (i = 0; i < tocEntriesToRemove.length; i++) {
617 toc.removeChild(tocEntriesToRemove[i]);
618 }
619
620 // Rebuild TOC entries.
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]621 var entries = tocEntries(document.getElementById("content"), toclevels);
622 for (var i = 0; i < entries.length; ++i) {
623 var entry = entries[i];
624 if (entry.element.id == "")
625 entry.element.id = "_toc_" + i;
626 var a = document.createElement("a");
627 a.href = "#" + entry.element.id;
628 a.appendChild(document.createTextNode(entry.text));
629 var div = document.createElement("div");
630 div.appendChild(a);
631 div.className = "toclevel" + entry.toclevel;
632 toc.appendChild(div);
633 }
634 if (entries.length == 0)
635 toc.parentNode.removeChild(toc);
636},
637
638
639/////////////////////////////////////////////////////////////////////
640// Footnotes generator
641/////////////////////////////////////////////////////////////////////
642
643/* Based on footnote generation code from:
644 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
645 */
646
647footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]648 // Delete existing footnote entries in case we're reloading the footnodes.
649 var i;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]650 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]651 if (!noteholder) {
652 return;
653 }
654 var entriesToRemove = [];
655 for (i = 0; i < noteholder.childNodes.length; i++) {
656 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]658 entriesToRemove.push(entry);
659 }
660 for (i = 0; i < entriesToRemove.length; i++) {
661 noteholder.removeChild(entriesToRemove[i]);
662 }
663
664 // Rebuild footnote entries.
665 var cont = document.getElementById("content");
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]666 var spans = cont.getElementsByTagName("span");
667 var refs = {};
668 var n = 0;
669 for (i=0; i<spans.length; i++) {
670 if (spans[i].className == "footnote") {
671 n++;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]672 var note = spans[i].getAttribute("data-note");
673 if (!note) {
674 // Use [\s\S] in place of . so multi-line matches work.
675 // Because JavaScript has no s (dotall) regex flag.
676 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
677 spans[i].innerHTML =
678 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
679 "' title='View footnote' class='footnote'>" + n + "</a>]";
680 spans[i].setAttribute("data-note", note);
681 }
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]682 noteholder.innerHTML +=
683 "<div class='footnote' id='_footnote_" + n + "'>" +
684 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
685 n + "</a>. " + note + "</div>";
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]686 var id =spans[i].getAttribute("id");
687 if (id != null) refs["#"+id] = n;
688 }
689 }
690 if (n == 0)
691 noteholder.parentNode.removeChild(noteholder);
692 else {
693 // Process footnoterefs.
694 for (i=0; i<spans.length; i++) {
695 if (spans[i].className == "footnoteref") {
696 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
697 href = href.match(/#.*/)[0]; // Because IE return full URL.
698 n = refs[href];
699 spans[i].innerHTML =
700 "[<a href='#_footnote_" + n +
701 "' title='View footnote' class='footnote'>" + n + "</a>]";
702 }
703 }
704 }
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]705},
706
707install: function(toclevels) {
708 var timerId;
709
710 function reinstall() {
711 asciidoc.footnotes();
712 if (toclevels) {
713 asciidoc.toc(toclevels);
714 }
715 }
716
717 function reinstallAndRemoveTimer() {
718 clearInterval(timerId);
719 reinstall();
720 }
721
722 timerId = setInterval(reinstall, 500);
723 if (document.addEventListener)
724 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
725 else
726 window.onload = reinstallAndRemoveTimer;
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]727}
728
729}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]730asciidoc.install();
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]731/*]]>*/
732</script>
733</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]734<body class="article">
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]735<div id="header">
736<h1>argv-array API</h1>
737</div>
738<div id="content">
739<div id="preamble">
740<div class="sectionbody">
741<div class="paragraph"><p>The argv-array API allows one to dynamically build and store
742NULL-terminated lists. An argv-array maintains the invariant that the
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]743<code>argv</code> member always points to a non-NULL array, and that the array is
744always NULL-terminated at the element pointed to by <code>argv[argc]</code>. This
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]745makes the result suitable for passing to functions expecting to receive
746argv from main(), or the <a href="api-run-command.html">run-command API</a>.</p></div>
Junio C Hamano1171ab42017-10-11 06:33:37[diff] [blame]747<div class="paragraph"><p>The string-list API (documented in string-list.h) is similar, but cannot be
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]748used for these purposes; instead of storing a straight string pointer,
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]749it contains an item structure with a <code>util</code> field that is not compatible
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]750with the traditional argv interface.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]751<div class="paragraph"><p>Each <code>argv_array</code> manages its own memory. Any strings pushed into the
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]752array are duplicated, and all memory is freed by argv_array_clear().</p></div>
753</div>
754</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]755<div class="sect1">
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]756<h2 id="_data_structures">Data Structures</h2>
757<div class="sectionbody">
758<div class="dlist"><dl>
759<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]760<code>struct argv_array</code>
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]761</dt>
762<dd>
763<p>
764 A single array. This should be initialized by assignment from
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]765 <code>ARGV_ARRAY_INIT</code>, or by calling <code>argv_array_init</code>. The <code>argv</code>
766 member contains the actual array; the <code>argc</code> member contains the
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]767 number of elements in the array, not including the terminating
768 NULL.
769</p>
770</dd>
771</dl></div>
772</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]773</div>
774<div class="sect1">
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]775<h2 id="_functions">Functions</h2>
776<div class="sectionbody">
777<div class="dlist"><dl>
778<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]779<code>argv_array_init</code>
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]780</dt>
781<dd>
782<p>
783 Initialize an array. This is no different than assigning from
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]784 <code>ARGV_ARRAY_INIT</code>.
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]785</p>
786</dd>
787<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]788<code>argv_array_push</code>
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]789</dt>
790<dd>
791<p>
792 Push a copy of a string onto the end of the array.
793</p>
794</dd>
795<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]796<code>argv_array_pushl</code>
Junio C Hamano4d61c4a2012-04-30 01:10:22[diff] [blame]797</dt>
798<dd>
799<p>
800 Push a list of strings onto the end of the array. The arguments
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]801 should be a list of <code>const char *</code> strings, terminated by a NULL
Junio C Hamano4d61c4a2012-04-30 01:10:22[diff] [blame]802 argument.
803</p>
804</dd>
805<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]806<code>argv_array_pushf</code>
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]807</dt>
808<dd>
809<p>
810 Format a string and push it onto the end of the array. This is a
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]811 convenience wrapper combining <code>strbuf_addf</code> and <code>argv_array_push</code>.
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]812</p>
813</dd>
814<dt class="hdlist1">
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]815<code>argv_array_pushv</code>
816</dt>
817<dd>
818<p>
819 Push a null-terminated array of strings onto the end of the array.
820</p>
821</dd>
822<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]823<code>argv_array_pop</code>
Junio C Hamano693e7092012-09-12 22:56:53[diff] [blame]824</dt>
825<dd>
826<p>
827 Remove the final element from the array. If there are no
828 elements in the array, do nothing.
829</p>
830</dd>
831<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]832<code>argv_array_clear</code>
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]833</dt>
834<dd>
835<p>
836 Free all memory associated with the array and return it to the
837 initial, empty state.
838</p>
839</dd>
Junio C Hamano76df4f72016-02-26 22:13:10[diff] [blame]840<dt class="hdlist1">
841<code>argv_array_detach</code>
842</dt>
843<dd>
844<p>
845 Disconnect the <code>argv</code> member from the <code>argv_array</code> struct and
846 return it. The caller is responsible for freeing the memory used
847 by the array, and by the strings it references. After detaching,
848 the <code>argv_array</code> is in a reinitialized state and can be pushed
849 into again.
850</p>
851</dd>
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]852</dl></div>
853</div>
854</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]855</div>
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]856<div id="footnotes"><hr /></div>
857<div id="footer">
858<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:53[diff] [blame]859Last updated
860 2018-01-26 15:11:04 PST
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]861</div>
862</div>
863</body>
864</html>